home *** CD-ROM | disk | FTP | other *** search
/ SGI Developer Toolbox 6.1 / SGI Developer Toolbox 6.1 - Disc 4.iso / src / exampleCode / viewkit / xcontact / onlineHelp / XContactHelp.sgm < prev   
Encoding:
Text File  |  1994-08-02  |  8.7 KB  |  223 lines
  1.  
  2. <dochelp>
  3.  
  4. <!-- 
  5.   ==================================================================
  6.   This block denotes a SGML-style comment.
  7.  
  8.   For those that are unfamiliar with SGML, this sample file
  9.   will try to cover the usage of a variety of the tags that
  10.   are used in the XHELP DTD. The examples shown in this sample
  11.   should be sufficient for a writer to produce a very high-quality,
  12.   functional help document for use with an application.
  13.  
  14.   It is best to view this sample once it has been published,
  15.   and then compare what you see in the viewing software to
  16.   the actual tags displayed in this file. 
  17.  
  18.   Each HelpTopic block written below displays how to use the
  19.   DTD to implement specific elements/constructs. It should be
  20.   fairly self-explanatory.
  21.  
  22.   A couple of things to look for when constructing/editing
  23.   your SGML file:
  24.  
  25.     o Make sure a starting element tag has an associated
  26.           end tag! If not, then the file will not compile
  27.           properly. This is analagous to missing a bracket
  28.           or paranthesis in a C program!
  29.  
  30.     o Ending elements can be fully-qualified to denote the
  31.       element they are ending, such as "</HelpTopic>" or
  32.       they can use the shorthand (but less obvious) notation
  33.       of "</>".
  34.  
  35.     o SGML is NOT case sensitive! "HELPTOPIC" is the same
  36.        as "helptopic", which is the same as "HelpTopic", etc.
  37.   ==================================================================
  38. -->
  39.  
  40. <HelpTopic HelpID="intro">
  41. <Helplabel>XContact Overview</Helplabel>
  42. <Description>
  43. <para>XContact is a simple address book that can be used to track your
  44. contact information.  You can customize the field labels for each different
  45. <glossterm>contact book</glossterm>, add unlimited size notes, and associate 
  46. face image to each contact record.</>
  47.  
  48. <para>XContact has two views.  The List View, XContact main window which lists 
  49. all of contact
  50. records in the <glossterm>contact book</glossterm>, and the Card View which is
  51. the detailed view of each record.
  52.  
  53. <para>
  54. You can perform a fast incremental search in the List
  55. View or global search using Search Dialog.
  56. </>
  57. <para>
  58. XContact always remembers the last contact book opened, and the window size.</>
  59.  
  60. <example>
  61. <Title>List View:</Title>
  62. <Figure ID="figure_01" Float="Yes">
  63.     <title>List View</title>
  64.     <Graphic fileref="listview.gif" format="GIF"></>
  65. </Figure>
  66.  
  67. List View is divided into three areas.  The Find: area is used to search a
  68. specific string in the list.  This search is incremental ie. as soon as you
  69. type in a character, the first item in the list that matches the Find: string
  70. will be highlited.  To find the next entry that matches the same string, hit 
  71. ENTER key.  To clear the Find: string completely hit ESC key.  
  72. The list area shows all the records
  73. in the contact book.  You can specify which fields you want to see in the list 
  74. (See Setup Fields Dialog).  
  75. The control area has an indicator label, which shows the record number
  76. of the currently 
  77. selected entry in the list, and/or the total number of records in the contact
  78. book and three control buttons, that you can use to open Card View for
  79. the currently selected record, to delete the currently selected record, and to
  80. add new record to contact book respectively.
  81.  
  82. <para>
  83. <Title>There are three menus available in List View:</Title>
  84. <Figure ID="figure_01" Float="Yes">
  85.     <title>File</title>
  86.     <Graphic fileref="file.gif" format="GIF"></>
  87. </Figure>
  88. Use File menu to create a new contact book, open an existing contact book, and
  89. manually save the currently opened contact book.  In most cases, you don't 
  90. need to manually do a save.  XContact automatically saves the modified record
  91. when you move to a different record or close the Card View.  In some cases eg.:
  92. when entering a lot of information into the notes field, you may want to 
  93. manually save the contact book, to avoid loosing a lot of work.
  94. You can use Import/Export to transfer the records from/to delimited text file.
  95. You can choose which fields you want to import/export, and what delimiter
  96. character to use using the import/export dialogs.  Use Print List to print all
  97. items in the list area.
  98. </>
  99.  
  100. <Figure ID="figure_01" Float="Yes">
  101.     <title>Card</title>
  102.     <Graphic fileref="card.gif" format="GIF"></>
  103. </Figure>
  104. The Card menu has similar functionalities as the control buttons.  In addition,
  105. you can bring up Search Dialog, close all open
  106. Card Viewers, and delete all records in the contact book.
  107.  
  108. <Figure ID="figure_01" Float="Yes">
  109.     <title>Preferences</title>
  110.     <Graphic fileref="preferences.gif" format="GIF"></>
  111. </Figure>
  112. Use Preferences menu to customize the field labels, list area, and record
  113. attributes.  XContact adds a new record in sorted order (ascending/descending)
  114. based on the name field.  If you subsequently modify the name field of 
  115. an existing
  116. record, XContact doesn't readjust that record position.  This might cause the
  117. records to be out of order.  You can then use Re-sort to make the records 
  118. back in sorted order. 
  119.  
  120. <Figure ID="figure_01" Float="Yes">
  121.     <title>Search Dialog</title>
  122.     <Graphic fileref="search.gif" format="GIF"></>
  123. </Figure>
  124. The Search Dialog can be used to search the whole contact book for a specified
  125. string.  You can optionally set case sensitivity, and include/exclude notes
  126. field in the search.  You can tell XContact to search forward or backward from
  127. the current record.  If a match is found, XContact will show the record in the
  128. active Card Viewer, or open one if no active Card Viewer is available.
  129.  
  130. <Figure ID="figure_01" Float="Yes">
  131.     <title>Setup Fields Dialog</title>
  132.     <Graphic fileref="setupfields.gif" format="GIF"></>
  133. </Figure>
  134. Use Setup Fields Dialog to determine which fields you want to see (and how wide)
  135. in the List View, and to rename the labels used for each field.  The new field
  136. labels are also used in the Card Viewer.
  137.  
  138. <Figure ID="figure_01" Float="Yes">
  139.     <title>Setup Attributes Dialog</title>
  140.     <Graphic fileref="setupattributes.gif" format="GIF"></>
  141. </Figure>
  142. Use Setup Attributes Dialog to determine the attribute style you want to use.
  143. Use Multiple Selections if there could be more than one attributes that can
  144. be applied to a record.  Otherwise, use Single Selection. For example: if you 
  145. use XContact to maintain your customer list,
  146. and a customer can be VAR, OEM, Distributor, and at any one time a customer
  147. can only be one of those, then use Single Selection.
  148.  
  149. <Figure ID="figure_01" Float="Yes">
  150.     <title>General Preferences Dialog</title>
  151.     <Graphic fileref="general.gif" format="GIF"></>
  152. </Figure>
  153. Use General Preferences Dialog to set the default directory location to put
  154. the <glossterm>contact book</glossterm> files, and the directories that XContact
  155. needs to search for face image files (multiple face location directories 
  156. must be separated
  157. by a semi-colon).  The image file name for each record will be determined by
  158. the e-mail entry of that record eg.: hajadi@sgi.com, the file name searched
  159. will be 'hajadi'.  You can toggle whether you want to show this image in the
  160. Card Viewer or not.  All image file formats supported by SGI ImageVision 
  161. library can be used ie.: SGI RGB, TIFF, and GIF.
  162.  
  163. <example>
  164. <Title>Card View:</Title>
  165. <Figure ID="figure_01" Float="Yes">
  166.     <title>Card View</title>
  167.     <Graphic fileref="cardview.gif" format="GIF"></>
  168. </Figure>
  169.  
  170. Card View shows the detailed information of each record.  You can open as 
  171. many as eight Card Viewers.  To bring up additional Card Viewers, uncheck the
  172. Active Viewer toggle.  You can move to the first, previous, next, and last
  173. record in the active Card Viewer.
  174.  
  175. <para>
  176. You can insert the content of a text file into the Notes field, and export the
  177. content of the Notes field into a text file using the Notes menu.
  178. </>
  179. <para>
  180. You can print the Card Viewer content using Print menu item in the Card menu.
  181. You can select whether you want the notes field to be printed or not.
  182. </>
  183.  
  184.  
  185. </>
  186.  
  187. </Description>
  188. </HelpTopic>
  189.  
  190.  
  191.  
  192. <!--
  193.   ==================================================================
  194.   If you wish to use/have a glossary of terms within your help text,
  195.   it is advised to put it at the end of your help "book", as shown 
  196.   here. NOTE: CR or other characters (#PCDATA) is NOT allowed 
  197.   between the <Glossary> and <Title> tags! (mixed content model)
  198.   ==================================================================
  199. -->
  200.  
  201. <Glossary>
  202. <Title>Glossary</Title>
  203. <GlossEntry>
  204. <GlossEntry>
  205. <GlossTerm>contact book</GlossTerm>
  206. <GlossDef>
  207. <para>This is where all contact record information is stored.  A contact
  208. book consists of two files: the data file (.DAT), and the index file (.NDX).
  209. The file extensions will be added automatically by XContact when you create
  210. a new contact book.</>
  211. </GlossDef>
  212. </GlossEntry></Glossary>
  213.  
  214.  
  215. <!--
  216.   ==================================================================
  217.   Don't forget the very last ending tag...!!!
  218.   ==================================================================
  219. -->
  220.  
  221. </dochelp>
  222.  
  223.